/*
 * This file is part of aion-emu <aion-emu.com>.
 *
 * aion-emu is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aion-emu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with aion-emu.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.aionengine.gameserver.model;

import org.apache.commons.lang.NotImplementedException;

import javax.xml.bind.annotation.XmlEnum;

/**
 * Basic enum with races.<br>
 * I believe that NPCs will have their own races, so it's quite comfortable to have it in the same place
 *
 * @author SoulKeeper
 */

@XmlEnum
public enum Race {
    /**
     * Playable races
     */
    ELYOS(0, new DescriptionId(1800481)),
    ASMODIANS(1, new DescriptionId(1800483)),

    /**
     * Npc races
     */
    LYCAN(2),
    CONSTRUCT(3),
    CARRIER(4),
    DRAKAN(5),
    LIZARDMAN(6),
    TELEPORTER(7),
    NAGA(8),
    BROWNIE(9),
    KRALL(10),
    SHULACK(11),
    BARRIER(12),
    PC_LIGHT_CASTLE_DOOR(13),
    PC_DARK_CASTLE_DOOR(14),
    DRAGON_CASTLE_DOOR(15),
    GCHIEF_LIGHT(16),
    GCHIEF_DARK(17),
    DRAGON(18),
    OUTSIDER(19),
    RATMAN(20),
    DEMIHUMANOID(21),
    UNDEAD(22),
    BEAST(23),
    MAGICALMONSTER(24),
    ELEMENTAL(25),
    LIVINGWATER(28),

    /**
     * Special races
     */
    NONE(26),
    PC_ALL(27),
    DEFORM(28),

    //2.6
    NEUT(29),
    //2.7 -- NOT SURE !!!
    GHENCHMAN_LIGHT(30),
    GHENCHMAN_DARK(31),
    //3.0
    EVENT_TOWER_DARK(32),
    EVENT_TOWER_LIGHT(33),
    GOBLIN(34),
    TRICODARK(35),
    NPC(36),
    // 3.5
    LIGHT(37),
    DARK(38),
    WORLD_EVENT_DEFTOWER(39),
    // 4.3
    ORC(40),
    DRAGONET(41),
    SIEGEDRAKAN(42),
    GCHIEF_DRAGON(43),
    WORLD_EVENT_BONFIRE(44);

    private int raceId;
    private DescriptionId descriptionId;

    /**
     * Constructors
     */
    private Race(int raceId) {
        this(raceId, null);
    }

    private Race(int raceId, DescriptionId descriptionId) {
        this.raceId = raceId;
        this.descriptionId = descriptionId;
    }

    /**
     * Accessors
     */
    public int getRaceId() {
        return raceId;
    }

    public boolean isPlayerRace() {
        return raceId < 2 || raceId == 27;
    }

    public DescriptionId getRaceDescriptionId() {
        if (descriptionId == null) {
            throw new NotImplementedException("Race name DescriptionId is unknown for race" + this);
        }
        return descriptionId;
    }

    public static Race getRaceByString(String fieldName) {
        for (Race r : values()) {
            if (r.toString().equals(fieldName))
                return r;
        }
        return null;
    }
}
